home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 7 / Amiga Format AFCD07 (Dec 1996, Issue 91).iso / serious / shareware / comms / internet / html-related / hsc / src_docs / messages.hsc < prev    next >
Text File  |  1996-09-18  |  12KB  |  329 lines
  1. <WEBPAGE chapter="hsc - " title="Messages"
  2.     PREV="examples.html"
  3.     NEXT="copy.html"
  4.     QTEXT=("What happened to the attitude you used to have at school<BR>"
  5.           +"What happened to the attitude when you broke all the rules")
  6.     QAUTHOR='The Farm, "Groovy Train"'>
  7.  
  8. <$macro MSG_NOTE><A HREF=":messages.html#msg_note">Note</A></$macro>
  9. <$macro MSG_STYLE><A HREF=":messages.html#msg_style">Bad style</A></$macro>
  10. <$macro MSG_WARN><A HREF=":messages.html#msg_warn">Warning</A></$macro>
  11. <$macro MSG_ERR><A HREF=":messages.html#msg_err">Error</A></$macro>
  12. <$macro MSG_FERR><A HREF=":messages.html#msg_ferr">Fatal error</A></$macro>
  13. <$macro OPTN_IGNORE><CODE><A HREF=":options.html#ignore">IGNORE</A></CODE></$macro>
  14.  
  15. <$macro msg id:string/r name:string/r class:enum("note|style|port|warning|error|fatal") undoc:bool>
  16. <P><DT><STRONG><$if cond=(set class)>
  17. <$if COND=(class="style")>bad style
  18. <$elseif COND=(class="fatal")>fatal error
  19. <$else><(class)>
  20. </$if></$if>
  21. <(id)>: <(name)></STRONG>
  22. <DD><$if COND=(undoc)>Undocumented.</$if>
  23. </$macro>
  24.  
  25. <$MACRO insattr>attribute <VAR>attrib</VAR></$MACRO>
  26. <$MACRO insent>entity <<VAR>entity</VAR>></$MACRO>
  27. <$MACRO instag>tag <<VAR>tag</VAR>></$MACRO>
  28. <$MACRO insendtag>end-tag <<VAR>tag</VAR>></$MACRO>
  29. <$MACRO insval>value <VAR>value</VAR></$MACRO>
  30.  
  31. <hsc> is able to produce lots of different warnings and
  32. errors when parsing html-files. The appearence looks something
  33. like:
  34.  
  35. <BLOCKQUOTE>
  36. <CODE>file (line#, colum#): class and message-id: message</CODE>
  37. </BLOCKQUOTE>
  38.  
  39. with
  40. <PRE>
  41.   file           input file that caused message
  42.   line#,         position in input file that caused error
  43.   colum#
  44.   class          one of <MSG_NOTE>, <MSG_WARN>, <MSG_ERR> or <MSG_FERR>
  45.   message        message text
  46. </PRE>
  47.  
  48. This can be modified using the CLI-option
  49. <KBD><A HREF="options.html#msgformat">MSGFORMAT</A></KBD>.
  50.  
  51. <HR>
  52.  
  53. <H2>Message Classes</H2>
  54.  
  55. <STRONG><A NAME="msg_note">Note</A></STRONG> is a message only for the
  56. users information. It can be suppressed using <OPTN_IGNORE>.
  57. <P>
  58. <STRONG><A NAME="msg_style">Bad style</A></STRONG> informs the user that
  59. his altough legal html-code includes constructs that indicate a bad style.
  60. It can be suppressed using <OPTN_IGNORE>.
  61. <P>
  62. <STRONG><A NAME="msg_port">Portability problem</A></STRONG> informs the
  63. user that his altough legal html-code includes constructs can lead to problems
  64. on old or buggy browsers.
  65. It can be suppressed using <OPTN_IGNORE>.
  66. <P>
  67. <STRONG><A NAME="msg_warn">Warning</A></STRONG> tells you that your source
  68. includes some problematic parts, that can lead to problems with several
  69. browsers.
  70. It can be suppressed using <OPTN_IGNORE>.
  71. <P>
  72. <STRONG><A NAME="msg_err">Error</A></STRONG> indicates that there is something
  73. wrong with your html-source. No output is written.
  74. <P>
  75. <STRONG><A NAME="msg_ferr">Fatal error</A></STRONG> tells you that something
  76. terrible has happened and there is no way to continue the conversion.
  77. No output is written.
  78. <P>
  79.  
  80. <HR>
  81.  
  82. <STRONG>Note:</STRONG> I've already started to collect the messages, but
  83. this list is not yet complete.
  84.  
  85. <DL>
  86. <MSG ID="1" CLASS="warning" NAME="unable to open project-file">
  87.  
  88. The project-file specified could not been open. This indicates
  89. no problem, if you specified a project-file using <op_prjfile>
  90. the first time; it will be created automatically after the
  91. html-object has successfully been processed.
  92.  
  93. <MSG ID="2" CLASS="fatal" NAME="project-file corrupt">
  94.  
  95. The data found in the project file are not of the required
  96. form. Most likely, the file-format-version is outdated.
  97. Remove the old file, <hsc> will create a new one next time it
  98. is invoked.
  99.  
  100. <MSG ID="3" CLASS="fatal" NAME="unexpected end of file">
  101. There are still characters to be read from input, but the file
  102. already ends; <hsc> tells you what it still expects to come.
  103.  
  104. <MSG ID="4" CLASS="error" NAME="" UNDOC>
  105.  
  106. <MSG ID="5" CLASS="error" NAME="" UNDOC>
  107. <MSG ID="6" CLASS="fatal" NAME="can not open <I>file</I> for input">
  108. An input file could not been opened. A more detailed message that tells
  109. you why is displayed, too.
  110.  
  111. <MSG ID="7" CLASS="error" NAME="" UNDOC>
  112. <MSG ID="8" CLASS="error" NAME="" UNDOC>
  113. <MSG ID="9" CLASS="error" NAME="" UNDOC>
  114. <MSG ID="10" CLASS="style" NAME='"click here" syndrome detected'>
  115. A keyword defined with the special attribute <CODE>HSC.CLICK-HERE</CODE>
  116. has been found within the text inside an anchor specification.<P>
  117. Ok, now again in english: you used some term like "Click here" inside
  118. the text describing a link. This is very clumsy and should be avoided;
  119. see <A HREF="http://www.cs.cmu.edu/~tilt/cgh/index.html#linktext">Composing
  120. Good HTML</A> for details.
  121.  
  122. <MSG ID="11" CLASS="error" NAME="unknown <instag>">
  123. You refered to an unknown tag or macro.
  124.  
  125. <MSG ID="12" CLASS="error" NAME="<instag> occured too often">
  126. A tag that is expected to occure only once appeared at least twice.
  127. Remove all unneccessary occurences of the tag.
  128.  
  129. <MSG ID="13" CLASS="warning" NAME="unmatched end-<instag>">
  130. You called a end-tag without using the corresponding start-tag
  131. before.
  132.  
  133. <MSG ID="14" CLASS="warning" NAME="illegal end-tag nesting">
  134. A end-tag appeard where a different end-tag was expected to
  135. appear before. Example: instead of
  136. <$SOURCE PRE>
  137.         <B><I>bold and italic</B></I>
  138. </$SOURCE>
  139. you should write
  140. <$SOURCE PRE>
  141.         <B><I>bold and italic</I></B>
  142. </$SOURCE>
  143.  
  144. <MSG ID="15" CLASS="warning" NAME="required <instag> missing">
  145. A tag that is required for every document is missing.
  146.  
  147. <MSG ID="16" CLASS="warning" NAME="end-<instag> missing">
  148. You called an start-tag, but didn't end it. Insert the required
  149. end-tag.
  150.  
  151. <MSG ID="17" CLASS="error" NAME="" UNDOC>
  152. <MSG ID="18" CLASS="warning" NAME="unknown entity">
  153. You used an entity, that <hsc> doesn't know. This can happen if you
  154. made a typo, or the entity has not been defined within
  155. <FILE>hsc.prefs</FILE>.
  156.  
  157. <MSG ID="19" CLASS="error" NAME="" UNDOC>
  158. <MSG ID="20" CLASS="error" NAME="reference to unknown attribute">
  159. You referered to an attribute that doesn't exist at all.
  160.  
  161. <MSG ID="21" CLASS="warning" NAME="path to URI not found: <I>file</I>">
  162. A tag points to a local resource that doesn't exist.
  163.  
  164. <MSG ID="22" CLASS="warning" NAME="argument without quote">
  165. You passed a value to an attribute, but did not embed it into single
  166. or double quotes. This can lead to problems with older browsers.
  167.  
  168. <MSG ID="23" CLASS="error" NAME="empty reference to <insattr>">
  169. An attribute referes to an attribute that has been defined, but no
  170. value has been set for. Usually, you try to refer to an attribute
  171. inside a macro, that no value has been passed to within the call
  172. of the macro.
  173.  
  174. <MSG ID="24" CLASS="error" NAME="" UNDOC>
  175. <MSG ID="25" CLASS="style" NAME="<TG>BLINK</TG> sucks">
  176. Some browser support the non-html-tag <TG>BLINK</TG>. It is used
  177. to make text blinking, which annoys many users. Additionally, most
  178. of them don't know how to configure their browser that it doesn't
  179. blink, so you really should avoid it.
  180.  
  181. <MSG ID="26" CLASS="error" NAME="" UNDOC>
  182. <MSG ID="27" CLASS="error" NAME="" UNDOC>
  183. <MSG ID="28" CLASS="error" NAME="" UNDOC>
  184. <MSG ID="29" CLASS="error" NAME="" UNDOC>
  185.  
  186. <MSG ID="30" CLASS="error" NAME='unmatched ">"'>
  187. A "greater than" sign appeared inside the text. You should write
  188. "<CODE>&gt;</CODE>" instead. This can also happen, if you made
  189. an error calling a tag, and <hsc>'s parser couln't recover.
  190.  
  191. <MSG ID="31" CLASS="error" NAME="" UNDOC>
  192. <MSG ID="32" CLASS="error" NAME="" UNDOC>
  193. <MSG ID="33" CLASS="error" NAME="" UNDOC>
  194. <MSG ID="34" CLASS="error" NAME="" UNDOC>
  195. <MSG ID="35" CLASS="error" NAME="unknown <insval> for enumerator <insattr>">
  196. You tried to set an enumerator to a value it doesn't support.
  197.  
  198. <MSG ID="36" CLASS="error" NAME="" UNDOC>
  199.  
  200. <MSG ID="37" CLASS="warning" NAME="<instag> is obsolete">
  201. The tag was defined within some old html-version, but should
  202. not be used any more (eg. <TG>LISTING</TG>).
  203.  
  204. <MSG ID="38" CLASS="warning" NAME="<instag> is only used by jerks">
  205. This tag is no legal html-tag and is only supportet by special
  206. browsers.
  207.  
  208. <MSG ID="39" CLASS="error" NAME="" UNDOC>
  209. <MSG ID="40" CLASS="error" NAME="" UNDOC>
  210. <MSG ID="41" CLASS="error" NAME="" UNDOC>
  211. <MSG ID="42" CLASS="error" NAME="" UNDOC>
  212. <MSG ID="43" CLASS="error" NAME="unknown attribute option <I>option</I>">
  213. You defined a new attribute, but used an
  214. <A HREF=":macro/attrib.html#flags">option</A> that is unknown.
  215.  
  216. <MSG ID="44" CLASS="error" NAME="required <insattr> missing">
  217. An attribute that is required has not been set within the call
  218. of a tag or macro.
  219.  
  220. <MSG ID="45" CLASS="error" NAME="" UNDOC>
  221. <MSG ID="46" CLASS="note" NAME="replaced <I>char</I> by <I>entity</I>">
  222. Informs you that a special character (non-7-bit-ASCII) has been replaced
  223. by it's corresponding entity.
  224.  
  225. <MSG ID="47" CLASS="error" NAME="" UNDOC>
  226. <MSG ID="48" CLASS="error" NAME="" UNDOC>
  227. <MSG ID="49" CLASS="error" NAME="" UNDOC>
  228. <MSG ID="50" CLASS="error" NAME="" UNDOC>
  229. <MSG ID="51" CLASS="error" NAME="" UNDOC>
  230. <MSG ID="52" CLASS="error" NAME="" UNDOC>
  231. <MSG ID="53" CLASS="error" NAME="" UNDOC>
  232.  
  233. <MSG ID="54" CLASS="warning" NAME="calling external command returned <I>value</I>">
  234.  
  235. You've called a shell-command using <TG>$exec</TG> and it returned a
  236. value unequal to zero, which usually denotes an error while processing
  237. the command. For error analysis, look at the output that the command
  238. (hopefully) has made.
  239.  
  240. <MSG ID="55" CLASS="error" NAME="" UNDOC>
  241. <MSG ID="56" CLASS="error" NAME="" UNDOC>
  242. <MSG ID="57" CLASS="error" NAME="" UNDOC>
  243. <MSG ID="58" CLASS="port" NAME="icon-<insent> found">
  244.  
  245. Icon-entities are (not-yet) widly supported.
  246.  
  247. <MSG ID="59" CLASS="error" NAME="" UNDOC>
  248. <MSG ID="60" CLASS="error" NAME="<instag> must be inside <instag>">
  249. Before you are allowed to use the first tag, the second tag has to
  250. occure before. Example: <TG>INPUT</TG> may only occure
  251. inside <TG>FORM</TG>.
  252.  
  253. <MSG ID="61" CLASS="error" NAME="<instag> not allowed within <instag>">
  254. A tag occures inside another tag that doesn't allowe this. For example,
  255. you can't recursively use <TG>A</TG> inside <TG>A</TG>.
  256.  
  257. <MSG ID="62" CLASS="error" NAME="no attributes allowed for end-tags">
  258. You tried to pass values to a end-tag or macro. If you need an attribute
  259. for a end-macro only, you still have to define and pass it within the
  260. start-macro; the end-macro will have access to all these attributes
  261. and its values.
  262.  
  263. <MSG ID="63" CLASS="warning" NAME="redefinance of <insattr>">
  264. You redefined an alredy existing attribute. If this occures during
  265. the definition of a new macro, you just tried to give two arguments the
  266. same name.
  267.  
  268. <MSG ID="64" CLASS="error" NAME="" UNDOC>
  269. <MSG ID="65" CLASS="error" NAME="" UNDOC>
  270. <MSG ID="66" CLASS="error" NAME="illegal end-tag">
  271. You tried to use a simple tag as a container, for example <TG>/IMG</TG>
  272.  
  273. <MSG ID="67" CLASS="error" NAME="" UNDOC>
  274. <MSG ID="68" CLASS="note" NAME="unknown filetype">
  275.  
  276. <hsc> could not <A HREF="features/getsize.html">determine the size</A>
  277. of a link destination.
  278.  
  279. <MSG ID="69" CLASS="error" NAME="illegal entity definition">
  280.  
  281. Somethings wrong with a <ln_deftag> or <ln_deficon> call.
  282.  
  283. <MSG ID="70" CLASS="error" NAME="" UNDOC>
  284. <MSG ID="71" CLASS="error" NAME="" UNDOC>
  285. <MSG ID="72" CLASS="warning" NAME="illegal color value">
  286.  
  287. A color value must fit the template `#rrggbb' or be one
  288. of the values declared in the special attribute
  289. <A HREF=":features/spcattr.html#colornames"><CODE>HSC.COLOR-NAMES</CODE></A>
  290. defined in <hsc.prefs>
  291.  
  292. <MSG ID="73" CLASS="error" NAME="" UNDOC>
  293. <MSG ID="74" CLASS="error" NAME="" UNDOC>
  294. <MSG ID="75" CLASS="error" NAME="" UNDOC>
  295. <MSG ID="76" CLASS="style" NAME="frames are disgusting">
  296.  
  297. This message should need no comment; anyway, read 
  298. <A HREF="http://www.ummed.edu:8000/pub/i/ijosh/frames/">Why Frames Suck</A> 
  299. for more details.
  300.  
  301. <MSG ID="77" CLASS="error" NAME="" UNDOC>
  302. <MSG ID="78" CLASS="style" NAME="succeeding white-space for <instag>">
  303.  
  304. See below.
  305.  
  306. <MSG ID="79" CLASS="style" NAME="preceding white-space for <insendtag>">
  307.  
  308. These two messages point out that instead of (read the underscore (`_')
  309. as a blank)
  310.  
  311. <BLOCKQUOTE>
  312. <TG>STRONG</TG>__important__<TG>/STRONG</TG>
  313. </BLOCKQUOTE>
  314.  
  315. you should better use
  316.  
  317. <BLOCKQUOTE>
  318. <TG>STRONG</TG>important<TG>/STRONG</TG>
  319. </BLOCKQUOTE>
  320.  
  321. It only affects the tags <TG>A</TG>, <TG>TITLE</TG>, headings and
  322. physical/locigal styles.
  323.  
  324.  
  325. </DL>
  326.  
  327. </WEBPAGE>
  328.  
  329.